/*
 * Copyright © 2021-2022 Cask Data, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package io.cdap.cdap.security.authorization.ldap.role.searcher;

import javax.naming.NamingException;
import javax.naming.directory.DirContext;

/**
 * Interface for providing connection to LDAP
 */
public interface LDAPClient {

    /**
     * Provides connection to LDAP
     *
     * @return {@link DirContext} to communicate with LDAP
     * @throws NamingException if fails to establish connection
     */
    DirContext getConnection() throws NamingException;

    /**
     * Test connection to LDAP
     */
    void testConnection();
}
